This document describes the document format used by Iceberg for Projects.

Iceberg's document are PropertyList file. Their content can be edited outside Iceberg using a text editor or the PropertyList Editor.app application. An Iceberg's document is structured as the Packages & Metapackages outline view is displaying it.

The first level of the hierarchy describes the Project object.

The Name token is currently only used to have a name for the root object of Packages and Metapackages hierarchy.

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <plist version="1.0"> <dict> <key>Hierarchy</key> <dict> </dict> <key>Name</key> <string>Project</string> <key>Settings</key> <dict> </dict> </dict> </plist>

Key Type Default value Description Hierarchy Dictionary Described below Hierarchy of Metapackages and Packages Name String "Project" Project Object Name Settings Dictionary Described below Project Settings

This dictionary contains the settings of the Project. They can be set via the Project Settings pane in Iceberg.

N/A

<key>10.1 Compatibility</key> <true/> <key>Build Path</key> <string>build</string> <key>Build Path Type</key> <integer>2</integer> <key>Comment</key> <string></string> <key>Remove .DS_Store</key> <true/> <key>Remove .pbdevelopment</key> <true/> <key>Remove CVS</key> <false/>

Key Type Default value Description 10.1 Compatibility Number true Build Packages that can be installed on Mac OS X 10.1 and prior Build Path String "build" Path where the Project needs to be build Build Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project Comment String "" Custom User's note on the project Remove .DS_Store Number true Remove every .DS_Store file in the pax archives. Remove .pbdevelopment Number true Remove every .pbdevelopment file in the pax archives. Remove CVS Number false Remove every CVS folder in the pax archives.

This dictionary describes either a Package or a Metapackage. The root item of the project hierarchy is also a component.

• The component status is used to know whether a component needs to be build or not.
• The IFPkgFlagPackageSelection value is used to know the default selection of a component: either it's required, selected or unselected. It can be superseded by the IFPkgFlagIsRequired.

<key>Attributes</key> <dict> </dict> <key>IFPkgFlagPackageSelection</key> <integer>0</integer> <key>Name</key> <string>Iceberg</string> <key>Status</key> <integer>1</integer> <key>Type</key> <integer>1</integer>

Key Type Default value Description Attributes Dictionary Described below Component attributes IFPkgFlagPackageSelection Number N/A Component selection mode: -1 Unselected 0 Selected 1 Required Name String "untitled component" Component name Status Number 1 Component status: 0 Unselected 1 Selected Type Number N/A Component type: 0 Metapackage 1 Package

Component > Attributes

This dictionary describes the attributes of a component.

There can be 2 templates of attributes depending on the component type.

• A Metapackage does not contain a description of files to install but instead a list of sub-components.
• A Package contains a description of files to install but has no sub-components.

Package

<key>Files</key> <dict> </dict> <key>Documents</key> <dict> </dict> <key>Scripts</key> <dict> </dict> <key>Settings</key> <dict> </dict>

<key>Components</key>
<dict>
</dict>
<key>Documents</key>
<dict>
</dict>
<key>Scripts</key>
<dict>
</dict>
<key>Settings</key>
<dict>
</dict>

Key Type Default value Description Components Array Described above List of components of the Metapackage Files Array Described below Files installed by the Package Documents Dictionary Described below Documents for the component Scripts Dictionary Described below Scripts and additional resources of the component Settings Dictionary Described below Settings of the component

Component > Attributes > Files

This dictionary describes which files the file archive of the package will contain and the options used to create the archive.

The IFPkgFlagDefaultLocation token needs to point to a folder in the file hierarchy when the package is not an imported package.
The Split Fork operation is made via the /Developer/Tools/SplitForks tool.

<key>Compress</key> <true/> <key>Hierarchy</key> <dict> </dict> <key>IFPkgFlagDefaultLocation</key> <string>/</string> <key>Imported Package</key> <false/> <key>Package Path</key> <string></string> <key>Split Forks</key> <true/>

Key Type Default value Description Compress Number true Compress the pax archive in zip Hierarchy Dictionary Described below Hierarchy of files to install IFPkgFlagDefaultLocation String "/" Default location where the files are to be installed Imported Package Number false Is the package an imported Package? Package Path String "" Location of the imported Package Split Forks Number true Split data and resource forks if needed

Component > Attributes > Files > File Item

This dictionary describes a file object from the hierarchy of files.

• A Standard Folder is a folder which can't be removed and which usually belongs to the default Mac OS X system file hierarchy. Standard folders are used in project templates to avoid setting wrong permissions to standard folders.
• A Custom Folder is a folder created by the user in the file hierarchy. The folder might not exist on disk.
• A Real File is a file or a folder which really exists on disk. If this file or folder is missing, the build will fail.

<key>Children</key> <array/> <key>GID</key> <integer>80</integer> <key>Path</key> <string>Utilities</string> <key>Path Type</key> <integer>0</integer> <key>Privileges</key> <integer>509</integer> <key>Type</key> <integer>1</integer> <key>UID</key> <integer>0</integer>

Key Type Default value Description Children Array N/A List of File Items included in this Item GID Number GID of the parent folder Group ID of the File Item Path String N/A Name or Path of the File Item Path Type Number N/A File Path Type: 0 Folder Name 1 Global Path 2 Relative path to project Privileges Number N/A Unix permissions of the File Item Type Number N/A File Item Type: 1 Standard Folder 2 Custom Folder 3 Real file UID Number N/A User ID of the File Item Search Rules Array No value Search Rules for the file item

Component > Attributes > Files > File Item > Search Rule

This dictionary describes a search rule for a file item.

Search rules are used to create the TokenDefinitions.plist file and the IFPkgPathMappings array for the Info.plist. Search Rules allows you to specify where the installer should look for previous version of a file/bundle.

<key>Status</key> <true/> <key>Name</key> <string>Untitled Rule</string> <key>Settings</key> <dict> </dict>

Key Type Default value Description Status Boolean true Status of the rule Name String Untitled Rule name of the rule Settings Dictionary Describe below Settings of the rule

Component > Attributes > Files > File Item > Search Rule > Settings

This dictionary describes the settings of a search rule.

There are 5 kinds of search rules:

• CheckPath
• CommonAppSearch
• LaunchServicesLookup
• BundleIdentifierSearch
• BundleVersionFilter

See Apple's documentation.

Key Type Default value Description searchPlugin String CheckPath Rule kind ... ... ... Keys/Values depends on the Rule kind

Component > Attributes > Documents

This dictionary describes all the documents which will be used to customize Installer.app when the package or metapackage are installed.

N/A

<key>Background Image</key> <dict> </dict> <key>License</key> <dict> </dict> <key>ReadMe</key> <dict> </dict> <key>Welcome</key> <dict> </dict>

Key Type Default value Description Background Image Dictionary Described below Background picture information License Dictionary Described below List of localized licenses ReadMe Dictionary Described below List of localized ReadMe Welcome Dictionary Described below List of localized Welcome

Component > Attributes > Documents > Background Image

This dictionary describes how and if a custom background image is displayed in Installer.app when the package or metapackage is installed.

The background image will only be displayed if the package or metapackage are not installed as parts of a metapackage.

<key>IFPkgFlagBackgroundAlignment</key> <integer>4</integer> <key>IFPkgFlagBackgroundScaling</key> <integer>1</integer> <key>Mode</key> <integer>0</integer> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer>

Key Type Default value Description IFPkgFlagBackgroundAlignment Number 4 Image alignment: 0 Center 1 Top 2 Left Top 3 Right Top 4 Left 5 Bottom 6 Left Bottom 7 Right Bottom 8 Right IFPkgFlagBackgroundScaling Number 1 Image scaling: 0 Proportionnally 1 To Fit 2 None Mode Number 0 Image status: 0 No image 1 Display image Path String "" Image path Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project

Component > Attributes > Documents > License

This dictionary describes if a license needs to be displayed in Installer.app when the package or metapackage are installed.

The license(s) will only be displayed if the package or metapackage are not installed as parts of a metapackage.

<key>International</key> <dict> <key>Keywords</key> <dict/> <key>Mode</key> <integer>0</integer> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> <key>Template</key> <string></string> </dict>

Key Type Default value Description Keywords Dictionary Empty Dictionary of key-values to use for the template Mode Number 0 License status: 0 No license 1 Display license 2 Display template license Path String "" License path Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project Template String "" License template name

Component > Attributes > Documents > ReadMe

This dictionary describes if a ReadMe needs to be displayed in Installer.app when the package or metapackage are installed.

The ReadMe will only be displayed if the package or metapackage are not installed as parts of a metapackage.

<key>International</key> <dict> <key>Mode</key> <integer>0</integer> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> </dict>

Key Type Default value Description Mode Number 0 ReadMe status: 0 No ReadMe 1 Display ReadMe Path String "" ReadMe path Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project

Component > Attributes > Documents > Welcome

This dictionary describes whether a custom Welcome needs to be displayed or the default one needs to be used.

A custom Welcome will only be displayed if the package or metapackage are not installed as parts of a metapackage.

<key>International</key> <dict> <key>Mode</key> <integer>0</integer> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> </dict>

Key Type Default value Description Mode Number 0 Welcome status: 0 Default Welcome 1 Display custom Welcome Path String "" Welcome path Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project

Component > Attributes > Scripts

This dictionary describes the scripts that will be use to customize the installation process and the additional resources used for this.

The Requirements won't be used for OS versions prior to 10.3.

Package

<dict> <key>Additional Resources</key> <dict> </dict> <key>Installation Scripts</key> <dict> </dict> <key>Requirements</key> <array> </array> </dict> /PRE>

Key Type Default value Description Additional Resources Dictionary Described below List of localized additional resources Installation Scripts Dictionary Described below Scripts run during installation Requirements Array Described below Requirements of the component

Component > Attributes > Scripts > Additional Resources

This dictionary describes the additional resources which needs to be added to the Resources folder of the package or metapackage.

To add VolumeCheck or InstallationCheck scripts to a package, you need to add them as Additional Resources.

<key>International</key> <array> <dict> <key>Path</key> <string>/Users/stephane/Desktop/SomeFile.txt</string> <key>Path Type</key> <integer>1</integer> <key>Status</key> <true/> </dict> </array>

Key Type Default value Description Path String Path to the file/folder to add Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project Status Number true if the file is to be added, false otherwise

Component > Attributes > Scripts > Installation Scripts

This dictionary describes which and if installation scripts are to be used for the package or metapackage.

The InstallationCheck and VolumeCheck scripts are not listed here. These 2 scripts are probably going to be deprecated and be completely replaced by "Requirements" attributes. To add VolumeCheck or InstallationCheck scripts to a package, you need to add them as Additional Resources.

<key>IFInstallationScriptsPostflight</key> <dict> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> <key>Status</key> <false/> </dict> <key>IFInstallationScriptsPostinstall</key> <dict> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> <key>Status</key> <false/> </dict> <key>IFInstallationScriptsPostupgrade</key> <dict> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> <key>Status</key> <false/> </dict> <key>IFInstallationScriptsPreflight</key> <dict> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> <key>Status</key> <false/> </dict> <key>IFInstallationScriptsPreinstall</key> <dict> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> <key>Status</key> <false/> </dict> <key>IFInstallationScriptsPreupgrade</key> <dict> <key>Path</key> <string></string> <key>Path Type</key> <integer>1</integer> <key>Status</key> <false/> </dict>

Key Type Default value Description Path String "" Script path Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project Status Number false true if the script is to be used, false otherwise

Component > Attributes > Scripts > Requirements

This dictionary describes the installation requirements or recommendations of the component.

The requirements mechanism is only available on Mac OS X 10.3 and later.

<dict> <key>AlertDialog</key> <dict> <key>International</key> <dict> <key>MessageKey</key> <string>Version is too old</string> <key>TitleKey</key> <string>Incorrect version</string> </dict> </dict> <key>LabelKey</key> <string>Sample requirement</string> <key>Level</key> <integer>0</integer> <key>SpecArgument</key> <string>fr.whitebox.pkg.iceberg</string> <key>SpecProperty</key> <string>IFMajorVersion</string> <key>SpecTag</key> <integer>4</integer> <key>SpecType</key> <string>package</string> <key>Status</key> <true/> <key>TestObject</key> <integer>10</integer> <key>TestOperator</key> <string>>=</string> </dict>

Key Type Default value Description AlertDialog Dictionary Message strings dictionary MessageKey String "" Message of the warning dialog TitleKey String "" Title of the warning dialog LabelKey String "untitled requirement" Short description of the requirement Level Number 0 Requirement level: 0 requires 1 recommends SpecArgument String "" Specification argument SpecProperty String Specification property SpecTag String 4 Specification tag: 4 package 2 gestalt 0 bundle 5 plist 1 file SpecType String "package" Specification type: package gestalt bundle plist file Status Number true Requirement status: true to create it, false otherwise TestObject String "" Object to compare the Specification property with TestOperator String >= Operator to use to compare the TestObject and the SpecProperty

Component > Attributes > Settings

This dictionary describes the settings related to information displayed in the Finder Info window and in Installer.app when the component is installed.

There are 2 possible formats depending on whether the component is a package or a metapackage. Metapackages don't have Options.

Package

<key>Description</key> <dict> </dict> <key>Display Information</key> <dict> </dict> <key>Options</key> <dict> </dict> <key>Version</key> <dict> </dict>

<key>Description</key>
<dict>
</dict>
<key>Display Information</key>
<dict>
</dict>
<key>Version</key>
<dict>
</dict>

Key Type Default value Description Description Dictionary Described below Component description Display Information Dictionary Described below List of localized display information Options Dictionary Described below Package options Version Dictionary Described below Component version

Component > Attributes > Settings > Description

This dictionary is used to build the .info file or Description.plist file for a package or metapackage.

The IFPkgDescriptionVersion and IFPkgDescriptionDeleteWarning are still not used by Installer.app.

<key>International</key> <dict> <key>IFPkgDescriptionDeleteWarning</key> <string></string> <key>IFPkgDescriptionDescription</key> <string></string> <key>IFPkgDescriptionTitle</key> <string>Iceberg</string> <key>IFPkgDescriptionVersion</key> <string>1.0</string> </dict>

Key Type Default value Description IFPkgDescriptionDeleteWarning String "" Reserved for future usage IFPkgDescriptionDescription String "" Short description of the component displayed in the Custom installation mode IFPkgDescriptionTitle String Component name IFPkgDescriptionVersion String "1.0" Reserved for future usage

Component > Attributes > Settings > Display Information

This dictionary describes information displayed in the Finder Information window and in the Finder.

N/A

<key>CFBundleGetInfoString</key> <string>Iceberg 1.0 Copyrights (c) 2004 Stéphane Sudre</string> <key>CFBundleIdentifier</key> <string>fr.whitebox.pkg.Iceberg</string> <key>CFBundleName</key> <string>Iceberg</string> <key>CFBundleShortVersionString</key> <string>1.0</string> <key>CFBundleIconFile</key> <string></string> <key>CFBundleIconFile Path Type</key> <integer><1/integer>

Key Type Default value Description CFBundleGetInfoString String "%%PROJECT_NAME%% 1.0 Copyrights (c) %%YEAR%%" Finder info string CFBundleIdentifier String "%%COMPANY_PACKAGE_IDENTIFIER%%.%%PROJECT_NAME%%" Bundle identifier CFBundleName String Component name Bundle name CFBundleShortVersionString String "1.0" Bundle version CFBundleIconFile String "" Absolute path to the custom icon file (.icns format) CFBundleIconFile Path Type Number N/A File Path Type: 1 Global Path 2 Relative path to project

Component > Attributes > Settings > Options

This dictionary describes the options for a Package.

As most of the options are not supported by Mac OS X 10.1, Iceberg will try to set the most appropriate options when it builds 10.1 compatible packages.

<key>IFPkgFlagAllowBackRev</key> <false/> <key>IFPkgFlagAuthorizationAction</key> <integer>2</integer> <key>IFPkgFlagFollowLinks</key> <false/> <key>IFPkgFlagInstallFat</key> <false/> <key>IFPkgFlagIsRequired</key> <false/> <key>IFPkgFlagOverwritePermissions</key> <false/> <key>IFPkgFlagRelocatable</key> <false/> <key>IFPkgFlagRestartAction</key> <integer>0</integer> <key>IFPkgFlagRootVolumeOnly</key> <true/> <key>IFPkgFlagUpdateInstalledLanguages</key> <false/>

Key Type Default value Description IFPkgFlagAllowBackRev Number false The installation allows to later install an earlier version of the package. IFPkgFlagAuthorizationAction Number 0 The authorizations the installation requires to proceed: 0 No Authorization Required 1 Admin Authorization 2 root Authorization IFPkgFlagFollowLinks Number false The installation does not replace symbolic links but resolves them and goes on the installation at the location links. IFPkgFlagInstallFat Number false The installation install all the binaries for multiple platforms. IFPkgFlagIsRequired Number false The package is a required component for the installation. IFPkgFlagOverwritePermissions Number false The permissions of directories in the installation overwrites the ones of the corresponding directories if they already exist in the destination volume. IFPkgFlagRelocatable Number false The user can choose the installation destination. IFPkgFlagRestartAction Number 0 The installation behavior after installation is completed: 0 No Restart Required 1 Recommended Restart 2 Required Restart 3 Shutdown Required 4 Logout Required IFPkgFlagRootVolumeOnly Number false The installation destination is limited to the boot volume. IFPkgFlagUpdateInstalledLanguages Number false The installation only updates the localizations already installed.

Component > Attributes > Settings > Version

This dictionary describes the major and minor versions of the package or metapackage.

Starting with Mac OS X 10.3, if you have a required package in a metapackage and you're installing the same metapackage and you switch to custom installation mode, the required metapackage can be disabled. Increasing the package version will insure the package to be required again.

<key>IFMajorVersion</key> <integer>1</integer> <key>IFMinorVersion</key> <integer>0</integer>

Key Type Default value Description IFMajorVersion Number 1 Major version IFMinorVersion Number 0 Minor version